home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsISHistoryInternal.idl < prev    next >
Text File  |  2006-05-08  |  4KB  |  110 lines
  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1999
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *   Radha Kulkarni (radha@netscape.com)
  24.  *
  25.  * Alternatively, the contents of this file may be used under the terms of
  26.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28.  * in which case the provisions of the GPL or the LGPL are applicable instead
  29.  * of those above. If you wish to allow use of your version of this file only
  30.  * under the terms of either the GPL or the LGPL, and not to allow others to
  31.  * use your version of this file under the terms of the MPL, indicate your
  32.  * decision by deleting the provisions above and replace them with the notice
  33.  * and other provisions required by the GPL or the LGPL. If you do not delete
  34.  * the provisions above, a recipient may use your version of this file under
  35.  * the terms of any one of the MPL, the GPL or the LGPL.
  36.  *
  37.  * ***** END LICENSE BLOCK ***** */
  38.  
  39. #include "nsISupports.idl"
  40. #include "nsIFactory.idl"
  41. #include "nsISHEntry.idl"
  42. #include "nsISHTransaction.idl"
  43.  
  44. interface nsISHistoryListener;
  45. interface nsIDocShell;
  46.  
  47. %{C++
  48. #define NS_SHISTORY_INTERNAL_CID \
  49. {0x5b4cba4c, 0xbf67, 0x499a, {0xae, 0x2c, 0x3f, 0x76, 0x65, 0x6f, 0x4a, 0x4e}}
  50.  
  51. #define NS_SHISTORY_INTERNAL_CONTRACTID "@mozilla.org/browser/shistory-internal;1"
  52. %}
  53.  
  54. [scriptable, uuid(494fac3c-64f4-41b8-b209-b4ada899613b)]
  55. interface nsISHistoryInternal: nsISupports
  56. {
  57.   /**
  58.    * Add a new Entry to the History List
  59.    * @param aEntry - The entry to add
  60.    * @param aPersist - If true this specifies that the entry should persist
  61.    * in the list.  If false, this means that when new entries are added
  62.    * this element will not appear in the session history list.
  63.    */
  64.    void  addEntry(in nsISHEntry aEntry, in boolean aPersist);
  65.  
  66.   /**
  67.    * Get the root transaction
  68.    */
  69.    readonly attribute nsISHTransaction rootTransaction;
  70.  
  71.   /**
  72.    * The toplevel docshell object to which this SHistory object belongs to.
  73.    */
  74.    attribute nsIDocShell rootDocShell;
  75.  
  76.   /** 
  77.    * Update the index maintained by sessionHistory
  78.    */
  79.    void updateIndex();
  80.  
  81.   /**
  82.    * Replace the nsISHEntry at a particular index
  83.    * @param aIndex - The index at which the entry shoud be replaced
  84.    * @param aReplaceEntry - The replacement entry for the index.
  85.    */
  86.    void replaceEntry(in long aIndex, in nsISHEntry aReplaceEntry);
  87.  
  88.   /** 
  89.    * Get handle to the history listener
  90.    */
  91.    readonly attribute nsISHistoryListener listener;
  92.  
  93.   /**
  94.    * Evict content viewers until the number of content viewers per tab
  95.    * is no more than gHistoryMaxViewers.  Also, count
  96.    * total number of content viewers globally and evict one if we are over
  97.    * our total max.  This is always called in Show(), after we destroy
  98.    * the previous viewer.
  99.    */
  100.    void evictContentViewers(in long previousIndex, in long index);
  101.  
  102.    /**
  103.     * Max number of total cached content viewers.  If the pref
  104.     * browser.sessionhistory.max_total_viewers is negative, then
  105.     * this value is calculated based on the total amount of memory.
  106.     * Otherwise, it comes straight from the pref.
  107.     */
  108.    readonly attribute long historyMaxTotalViewers;
  109. };
  110.